Improve FLAME Node documentation clarity and NGINX ingress requirement#101
Merged
Merged
Conversation
- Add requirement for NGINX Ingress Controller for FLAME Node deployments - Replace "robot" with "client" in documentation (and screenshots in "registering in the hub" chapter) - Clarify values.yaml handling (edit vs. manual creation depending on installation method)
Contributor
📝 WalkthroughWalkthroughThis pull request updates documentation and configuration to transition from "Robots" terminology to "Clients" throughout the admin guides, navigation menu, and node deployment instructions. The sidebar configuration is updated, core client administration documentation is provided, and deployment guides are enhanced with additional clarity on prerequisites, infrastructure verification, and configuration options. ChangesRobots to Clients Terminology Transition
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint install timed out. The project may have too many dependencies for the sandbox. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/guide/admin/clients.md`:
- Line 28: Replace the misspelled word in the sentence "4. **Delete** clients by
clicking the red thrash can button on the right."—change "thrash can" to "trash
can" so the line reads "4. **Delete** clients by clicking the red trash can
button on the right."
- Around line 3-5: The paragraph in src/guide/admin/clients.md should be
tightened to explicitly mention clients, replace the vague "[here]" link text,
and align with the realms doc; update the sentence that currently reads "In
order to manage your identity-providers, nodes, ... you need to get an
organization..." to a concise line that names clients (e.g., "identity
providers, nodes, clients, and users"), requests contacting us to obtain a realm
for management, and replace "[here](/guide/admin/realms)" with explicit link
text like "realm docs" (keeping the same /guide/admin/realms URL) so the Clients
page and the linked Realms documentation stay aligned.
- Around line 12-31: clients.md still references outdated screenshot assets
named hub_robots*.png; update the markdown in src/guide/admin/clients.md (the
image links referencing /images/ui_images/hub_robots.png,
hub_robots_details.png, hub_robots_roles.png, hub_robots_permissions.png,
hub_robots_add.png) to point to the new image filenames or replace/add the
corresponding files under src/public/images/ui_images so the links resolve, then
commit the refreshed images and/or updated links so the PR includes the
screenshot refresh.
In `@src/guide/deployment/node-installation.md`:
- Line 54: Update the wording so the NGINX Ingress Controller requirement is
scoped to when the chart is used with expose.type: "ingress": change the
sentence to state that the FLAME Node is designed to work with an NGINX Ingress
Controller when expose.type is "ingress", and add a short note that users who
set expose.type: "gateway" must instead meet the Gateway API/controller
requirements; reference the expose.type configuration and the Gateway
API/controller in the sentence so readers know which path each controller
requirement applies to.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 47c1dc6a-2d93-4282-bde2-db2e8f34f34b
⛔ Files ignored due to path filters (2)
src/public/images/ui_images/hub_client.pngis excluded by!**/*.pngsrc/public/images/ui_images/hub_node_crypto.pngis excluded by!**/*.png
📒 Files selected for processing (7)
src/.vitepress/routes/sidebar/admin.tssrc/getting-started/components.mdsrc/guide/admin/clients.mdsrc/guide/admin/index.mdsrc/guide/admin/realms.mdsrc/guide/deployment/node-installation.mdsrc/guide/deployment/node-registration.md
Comment on lines
3
to
5
| In order to manage your identity-providers, nodes, ... you need to get an organization. Please contact us, | ||
| such we can provide you a realm in which you can manage all your nodes, users and identity providers. | ||
| For more details on realms click [here](/guide/admin/realms). |
Contributor
There was a problem hiding this comment.
Tighten the realm notice.
This paragraph still leaves out clients and uses [here], so the updated Clients page and the linked realm docs stay aligned.
Suggested wording
- In order to manage your identity-providers, nodes, ... you need to get an organization. Please contact us,
- such we can provide you a realm in which you can manage all your nodes, users and identity providers.
- For more details on realms click [here](/guide/admin/realms).
+ In order to manage your identity-providers, clients, nodes, ... you need to get an organization. Please contact us,
+ so we can provide you a realm in which you can manage all your clients, nodes, users, and identity providers.
+ For more details on realms, see the [realms guide](/guide/admin/realms).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| In order to manage your identity-providers, nodes, ... you need to get an organization. Please contact us, | |
| such we can provide you a realm in which you can manage all your nodes, users and identity providers. | |
| For more details on realms click [here](/guide/admin/realms). | |
| In order to manage your identity-providers, clients, nodes, ... you need to get an organization. Please contact us, | |
| so we can provide you a realm in which you can manage all your clients, nodes, users, and identity providers. | |
| For more details on realms, see the [realms guide](/guide/admin/realms). |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 5-5: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/guide/admin/clients.md` around lines 3 - 5, The paragraph in
src/guide/admin/clients.md should be tightened to explicitly mention clients,
replace the vague "[here]" link text, and align with the realms doc; update the
sentence that currently reads "In order to manage your identity-providers,
nodes, ... you need to get an organization..." to a concise line that names
clients (e.g., "identity providers, nodes, clients, and users"), requests
contacting us to obtain a realm for management, and replace
"[here](/guide/admin/realms)" with explicit link text like "realm docs" (keeping
the same /guide/admin/realms URL) so the Clients page and the linked Realms
documentation stay aligned.
Source: Linters/SAST tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Release Notes